<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>v_hdmirxss1: xhdmi_menu.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">v_hdmirxss1
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xhdmi__menu_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xhdmi_menu.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This is the main header file for the Xilinx Menu implementation as used in the HDMI example design. </p>
<p><b>Software Initialization &amp; Configuration</b></p>
<p><b>Interrupts </b></p>
<p><b> Virtual Memory </b></p>
<p>This driver supports Virtual Memory. The RTOS is responsible for calculating the correct device base address in Virtual Memory space.</p>
<p><b> Threads </b></p>
<p>This driver is not thread safe. Any needs for threads or thread mutual exclusion must be satisfied by the layer above this driver.</p>
<p><b> Asserts </b></p>
<p>Asserts are used within all Xilinx drivers to enforce constraints on argument values. Asserts can be turned off on a system-wide basis by defining at compile time, the NDEBUG identifier. By default, asserts are turned on and it is recommended that users leave asserts on during development.</p>
<p><b> Building the driver </b></p>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver     Who  Date       Changes
</p>
<hr/>
<p>
X.X     ..   DD-MM-YYYY ..
1.0     mmo  24-04-2019 Initial version</pre><pre></pre><p><b>Software Initialization &amp; Configuration</b></p>
<p><b>Interrupts </b></p>
<p><b> Virtual Memory </b></p>
<p>This driver supports Virtual Memory. The RTOS is responsible for calculating the correct device base address in Virtual Memory space.</p>
<p><b> Threads </b></p>
<p>This driver is not thread safe. Any needs for threads or thread mutual exclusion must be satisfied by the layer above this driver.</p>
<p><b> Asserts </b></p>
<p>Asserts are used within all Xilinx drivers to enforce constraints on argument values. Asserts can be turned off on a system-wide basis by defining at compile time, the NDEBUG identifier. By default, asserts are turned on and it is recommended that users leave asserts on during development.</p>
<p><b> Building the driver </b></p>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who  Date       Changes
</p>
<hr/>
<p>
X.X   ..   DD-MM-YYYY ..
1.00   GM     05/03/18 Initial release.
</pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_hdmi___menu_config.html">XHdmi_MenuConfig</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The HDMI menu configuration.  <a href="struct_x_hdmi___menu_config.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_hdmi___menu___ex_des___ctrlr.html">XHdmi_Menu_ExDes_Ctrlr</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The HDMI ExDes Settings.  <a href="struct_x_hdmi___menu___ex_des___ctrlr.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_hdmi___menu.html">XHdmi_Menu</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The HDMI menu instance data.  <a href="struct_x_hdmi___menu.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a896c61616bb6eadcdfe1b51f08ae7d66"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xhdmi__menu_8h.html#a896c61616bb6eadcdfe1b51f08ae7d66">XHDMI_MENU_H_</a></td></tr>
<tr class="memdesc:a896c61616bb6eadcdfe1b51f08ae7d66"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent circular inclusions by using protection macros.  <a href="#a896c61616bb6eadcdfe1b51f08ae7d66">More...</a><br/></td></tr>
<tr class="separator:a896c61616bb6eadcdfe1b51f08ae7d66"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a8425d7c3a20915745a94c5b552376d4a"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xhdmi__menu_8h.html#a8425d7c3a20915745a94c5b552376d4a">XHdmi_MenuType</a> </td></tr>
<tr class="memdesc:a8425d7c3a20915745a94c5b552376d4a"><td class="mdescLeft">&#160;</td><td class="mdescRight">The HDMI menu types.  <a href="xhdmi__menu_8h.html#a8425d7c3a20915745a94c5b552376d4a">More...</a><br/></td></tr>
<tr class="separator:a8425d7c3a20915745a94c5b552376d4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a886549f4c5a89353a3dd7e563758d439"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xhdmi__menu_8h.html#a886549f4c5a89353a3dd7e563758d439">XHdmi_MenuInitialize</a> (<a class="el" href="struct_x_hdmi___menu.html">XHdmi_Menu</a> *InstancePtr, u32 UartBaseAddress, u8 *ForceIndependentPtr, u8 *SystemEventPtr, u8 *IsTxPresentPtr, u8 *IsRxPresentPtr, void *ChangeColorbarOutputCB, void *ConfigureTpgEnableInputCB, void *ToggleHdmiRxHpdCB)</td></tr>
<tr class="memdesc:a886549f4c5a89353a3dd7e563758d439"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function takes care of the HDMI menu initialization.  <a href="#a886549f4c5a89353a3dd7e563758d439">More...</a><br/></td></tr>
<tr class="separator:a886549f4c5a89353a3dd7e563758d439"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aef0c77222dd933d65ac89908b7791f34"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xhdmi__menu_8h.html#aef0c77222dd933d65ac89908b7791f34">XHdmi_MenuProcess</a> (<a class="el" href="struct_x_hdmi___menu.html">XHdmi_Menu</a> *InstancePtr, u8 TxBusy)</td></tr>
<tr class="memdesc:aef0c77222dd933d65ac89908b7791f34"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is called to trigger the HDMI menu statemachine.  <a href="#aef0c77222dd933d65ac89908b7791f34">More...</a><br/></td></tr>
<tr class="separator:aef0c77222dd933d65ac89908b7791f34"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8507711886833ab068231566550c677e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xhdmi__menu_8h.html#a8507711886833ab068231566550c677e">XHdmi_MenuReset</a> (<a class="el" href="struct_x_hdmi___menu.html">XHdmi_Menu</a> *InstancePtr)</td></tr>
<tr class="memdesc:a8507711886833ab068231566550c677e"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function resets the menu to the main menu.  <a href="#a8507711886833ab068231566550c677e">More...</a><br/></td></tr>
<tr class="separator:a8507711886833ab068231566550c677e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="a896c61616bb6eadcdfe1b51f08ae7d66"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XHDMI_MENU_H_</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Prevent circular inclusions by using protection macros. </p>

</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="a8425d7c3a20915745a94c5b552376d4a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="xhdmi__menu_8h.html#a8425d7c3a20915745a94c5b552376d4a">XHdmi_MenuType</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The HDMI menu types. </p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a886549f4c5a89353a3dd7e563758d439"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XHdmi_MenuInitialize </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_hdmi___menu.html">XHdmi_Menu</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>UartBaseAddress</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8 *&#160;</td>
          <td class="paramname"><em>ForceIndependentPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8 *&#160;</td>
          <td class="paramname"><em>SystemEventPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8 *&#160;</td>
          <td class="paramname"><em>IsTxPresentPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8 *&#160;</td>
          <td class="paramname"><em>IsRxPresentPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>ChangeColorbarOutputCB</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>ConfigureTpgEnableInputCB</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>ToggleHdmiRxHpdCB</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function takes care of the HDMI menu initialization. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_hdmi___menu.html" title="The HDMI menu instance data. ">XHdmi_Menu</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

<p>References <a class="el" href="struct_x_hdmi___menu.html#a638ef2416724847ef77c5f624b1eb160">XHdmi_Menu::CurrentMenu</a>, <a class="el" href="struct_x_hdmi___menu.html#a3afec6a5e8194f75f7c5972a2ab5e883">XHdmi_Menu::UartBaseAddress</a>, and <a class="el" href="struct_x_hdmi___menu.html#aab8ef085202660c5ff4fd1148fefc6ce">XHdmi_Menu::Value</a>.</p>

<p>Referenced by <a class="el" href="xhdmi__example_8c.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main()</a>.</p>

</div>
</div>
<a class="anchor" id="aef0c77222dd933d65ac89908b7791f34"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XHdmi_MenuProcess </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_hdmi___menu.html">XHdmi_Menu</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>TxBusy</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is called to trigger the HDMI menu statemachine. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_hdmi___menu.html" title="The HDMI menu instance data. ">XHdmi_Menu</a> instance.</td></tr>
    <tr><td class="paramname">input</td><td>is the value used for the next menu state decoder.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

<p>References <a class="el" href="struct_x_hdmi___menu.html#a638ef2416724847ef77c5f624b1eb160">XHdmi_Menu::CurrentMenu</a>, <a class="el" href="struct_x_hdmi___menu.html#a3afec6a5e8194f75f7c5972a2ab5e883">XHdmi_Menu::UartBaseAddress</a>, and <a class="el" href="struct_x_hdmi___menu.html#aab8ef085202660c5ff4fd1148fefc6ce">XHdmi_Menu::Value</a>.</p>

<p>Referenced by <a class="el" href="xhdmi__example_8c.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main()</a>.</p>

</div>
</div>
<a class="anchor" id="a8507711886833ab068231566550c677e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XHdmi_MenuReset </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_hdmi___menu.html">XHdmi_Menu</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function resets the menu to the main menu. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_hdmi___menu.html" title="The HDMI menu instance data. ">XHdmi_Menu</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

<p>References <a class="el" href="struct_x_hdmi___menu.html#a638ef2416724847ef77c5f624b1eb160">XHdmi_Menu::CurrentMenu</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
